IntelliJ Platform Gradle Plugin/org.jetbrains.intellij.platform.gradle.tasks.aware/SandboxAware

SandboxAware

interface SandboxAware : IntelliJPlatformVersionAware

The interface provides quick access to the sandbox container and specific directories located within it. The path to the sandbox container is obtained using the IntelliJPlatformExtension.sandboxContainer extension property and the type and version of the IntelliJ Platform applied to the project. Paths respect custom IntelliJ Platform when combined with CustomIntelliJPlatformVersionAware.

See also

Inheritors

Properties

Link copied to clipboard
@get:Internal
open val frontendPropertiesFile: Provider<RegularFile>

Path to a properties file which will be used to configure the frontend process if the IDE is started in Split Mode.

Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intelliJPlatformConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM configuration with the IntelliJ Platform dependency added. It should not be directly accessed.

Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intelliJPlatformPluginConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_PLUGIN_DEPENDENCY configuration with the optional custom IntelliJ Platform plugins dependencies added. It should not be directly accessed.

Link copied to clipboard
@get:Internal
open val platformPath: Path

Provides access to the IntelliJ Platform dependency artifact path.

Link copied to clipboard
@get:Internal
open val productInfo: ProductInfo

Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory.

Link copied to clipboard
@get:Internal
abstract val sandboxConfigDirectory: DirectoryProperty

A configuration directory located within the sandboxContainerDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxContainerDirectory: DirectoryProperty

The container for all sandbox-related directories. The directory name depends on the platform type and version currently used for running a task.

Link copied to clipboard
@get:Internal
abstract val sandboxLogDirectory: DirectoryProperty

A log directory located within the sandboxContainerDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxPluginsDirectory: DirectoryProperty

A plugins directory located within the sandboxContainerDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxSuffix: Property<String>

Represents the suffix used i.e., for test-related tasks.

Link copied to clipboard
@get:Internal
abstract val sandboxSystemDirectory: DirectoryProperty

A system directory located within the sandboxContainerDirectory.

Functions

Link copied to clipboard
open fun validateIntelliJPlatformVersion()

Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.